﻿/*
Copyright (c) 2013, Marc Tanti
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the www.marctanti.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Drawing;
using MARIA.level.situation;

namespace MARIA.level.square
{
    [Serializable]
    /// <summary>
    /// A square in the grid where the robot can move on.
    /// </summary>
    public abstract class Square
    {

        /// <summary>
        /// A string which represents this square.
        /// </summary>
        public string TextualRepresentation
        {
            get
            {
                return textualRepresentation;
            }
        }
        private string textualRepresentation;

        /// <summary>
        /// The image of the square in order to display it.
        /// </summary>
        public Image SquareImage
        {
            get
            {
                return squareImage;
            }
        }
        private Image squareImage;

        /// <summary>
        /// The character which represents this square (used in text files and so on).
        /// </summary>
        public char CharacterRepresentation
        {
            get
            {
                return characterRepresentation;
            }
        }
        private char characterRepresentation;

        /// <summary>
        /// Modify the situation to reflect the consequences of stepping on this square.
        /// </summary>
        /// <param name="situation">The situation to modify.</param>
        public abstract void SteppedOnResult(Situation situation);

        /// <summary>
        /// Initializes a new instance of the Square class using a textual representation, an image of the square and a character representation.
        /// </summary>
        /// <param name="textualRepresentation">The textual representation.</param>
        /// <param name="squareImage">The image of the square.</param>
        /// <param name="characterRepresentation">The character which represents the square.</param>
        public Square(string textualRepresentation, Image squareImage, char characterRepresentation)
        {
            this.squareImage = squareImage;
            this.characterRepresentation = characterRepresentation;
            this.textualRepresentation = textualRepresentation;
        }

    }
}
